<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EasyXPlus: EasyXPlus::RectClipRegion Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">EasyXPlus
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">EasyXPlus is a simple graphic library for C++ BEGINNERS under Windows.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>EasyXPlus</b></li><li class="navelem"><a class="el" href="class_easy_x_plus_1_1_rect_clip_region.html">RectClipRegion</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_easy_x_plus_1_1_rect_clip_region-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">EasyXPlus::RectClipRegion Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A clip region class in rectangle shape.  
 <a href="class_easy_x_plus_1_1_rect_clip_region.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="easy_clip_8h_source.html">easyClip.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for EasyXPlus::RectClipRegion:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_easy_x_plus_1_1_rect_clip_region.png" usemap="#EasyXPlus::RectClipRegion_map" alt=""/>
  <map id="EasyXPlus::RectClipRegion_map" name="EasyXPlus::RectClipRegion_map">
<area href="class_easy_x_plus_1_1_clip_region.html" title="A clip region interface. " alt="EasyXPlus::ClipRegion" shape="rect" coords="0,0,165,24"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union &#160;</td><td class="memItemRight" valign="bottom"><b>ClipUnion</b></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9c0b88aa316f1b0244693e3213a976b3"><td class="memItemLeft" align="right" valign="top"><a id="a9c0b88aa316f1b0244693e3213a976b3"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_easy_x_plus_1_1_rect_clip_region.html#a9c0b88aa316f1b0244693e3213a976b3">RectClipRegion</a> (const <a class="el" href="class_easy_x_plus_1_1_rect_region.html">RectRegion</a> &amp;region)</td></tr>
<tr class="memdesc:a9c0b88aa316f1b0244693e3213a976b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a rectangle clip region with the given region. <br /></td></tr>
<tr class="separator:a9c0b88aa316f1b0244693e3213a976b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Logic operations of clip regions. These opertions will not be performed</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>immediately until the <a class="el" href="class_easy_x_plus_1_1_rect_clip_region.html#af9a6c626fa17f69419d2b7909ee8b26a" title="Apply this clip region and all its logic operations to the default window. ">associateToWindow()</a> function is called. Logic operations are performed in order. </p>
</div></td></tr>
<tr class="memitem:ada6f725f92082d5bd2339c0b19470411"><td class="memItemLeft" align="right" valign="top"><a id="ada6f725f92082d5bd2339c0b19470411"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_easy_x_plus_1_1_rect_clip_region.html#ada6f725f92082d5bd2339c0b19470411">exclude</a> (const <a class="el" href="class_easy_x_plus_1_1_rect_region.html">RectRegion</a> &amp;region)</td></tr>
<tr class="memdesc:ada6f725f92082d5bd2339c0b19470411"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exclude the given region from the inner clip region. <br /></td></tr>
<tr class="separator:ada6f725f92082d5bd2339c0b19470411"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27e7dfa54175389d08ca73f5948a7098"><td class="memItemLeft" align="right" valign="top"><a id="a27e7dfa54175389d08ca73f5948a7098"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_easy_x_plus_1_1_rect_clip_region.html#a27e7dfa54175389d08ca73f5948a7098">intersect</a> (const <a class="el" href="class_easy_x_plus_1_1_rect_region.html">RectRegion</a> &amp;region)</td></tr>
<tr class="memdesc:a27e7dfa54175389d08ca73f5948a7098"><td class="mdescLeft">&#160;</td><td class="mdescRight">Intersect the inner clip region with the given region. <br /></td></tr>
<tr class="separator:a27e7dfa54175389d08ca73f5948a7098"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf6470a9cff67ac528252d42e66f42a0"><td class="memItemLeft" align="right" valign="top"><a id="acf6470a9cff67ac528252d42e66f42a0"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_easy_x_plus_1_1_rect_clip_region.html#acf6470a9cff67ac528252d42e66f42a0">unionn</a> (const <a class="el" href="class_easy_x_plus_1_1_rect_region.html">RectRegion</a> &amp;region)</td></tr>
<tr class="memdesc:acf6470a9cff67ac528252d42e66f42a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Union the inner clip region with the given region. <br /></td></tr>
<tr class="separator:acf6470a9cff67ac528252d42e66f42a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28ec6534c9250d03cb4fce84d781bb07"><td class="memItemLeft" align="right" valign="top"><a id="a28ec6534c9250d03cb4fce84d781bb07"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_easy_x_plus_1_1_rect_clip_region.html#a28ec6534c9250d03cb4fce84d781bb07">move</a> (int horizontalOffset, int verticalOffset)</td></tr>
<tr class="memdesc:a28ec6534c9250d03cb4fce84d781bb07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move the inner clip region with the given x-y offsets. <br /></td></tr>
<tr class="separator:a28ec6534c9250d03cb4fce84d781bb07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa87de1fd2b2357fb8e8b81c2550ad5d0"><td class="memItemLeft" align="right" valign="top"><a id="aa87de1fd2b2357fb8e8b81c2550ad5d0"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_easy_x_plus_1_1_rect_clip_region.html#aa87de1fd2b2357fb8e8b81c2550ad5d0">set</a> (const <a class="el" href="class_easy_x_plus_1_1_rect_region.html">RectRegion</a> &amp;region)</td></tr>
<tr class="memdesc:aa87de1fd2b2357fb8e8b81c2550ad5d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the inner clip region to the given region and clear all logic operations. <br /></td></tr>
<tr class="separator:aa87de1fd2b2357fb8e8b81c2550ad5d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41bd2a048eee3d49781f712c3238f6f3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_easy_x_plus_1_1_rect_clip_region.html#a41bd2a048eee3d49781f712c3238f6f3">clear</a> ()</td></tr>
<tr class="memdesc:a41bd2a048eee3d49781f712c3238f6f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the inner clip region and all logic operations on the inner clip region.  <a href="#a41bd2a048eee3d49781f712c3238f6f3">More...</a><br /></td></tr>
<tr class="separator:a41bd2a048eee3d49781f712c3238f6f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr class="memitem:af9a6c626fa17f69419d2b7909ee8b26a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_easy_x_plus_1_1_rect_clip_region.html#af9a6c626fa17f69419d2b7909ee8b26a">associateToWindow</a> ()</td></tr>
<tr class="memdesc:af9a6c626fa17f69419d2b7909ee8b26a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Apply this clip region and all its logic operations to the default window.  <a href="#af9a6c626fa17f69419d2b7909ee8b26a">More...</a><br /></td></tr>
<tr class="separator:af9a6c626fa17f69419d2b7909ee8b26a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9e43a3a7d481b786a9a57efa814b8ff"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_easy_x_plus_1_1_rect_clip_region.html#ac9e43a3a7d481b786a9a57efa814b8ff">cancelAssociation</a> ()</td></tr>
<tr class="memdesc:ac9e43a3a7d481b786a9a57efa814b8ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel applying the clip region.  <a href="#ac9e43a3a7d481b786a9a57efa814b8ff">More...</a><br /></td></tr>
<tr class="separator:ac9e43a3a7d481b786a9a57efa814b8ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A clip region class in rectangle shape. </p>
<dl class="section remark"><dt>Remarks</dt><dd>Although the basic shape of this clip region is rectangle, complex clip regions that are not strictly rectangles can also be creaetd from applying a lot of logic operations(exclude, intersect and so on). </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="af9a6c626fa17f69419d2b7909ee8b26a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9a6c626fa17f69419d2b7909ee8b26a">&#9670;&nbsp;</a></span>associateToWindow()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void EasyXPlus::RectClipRegion::associateToWindow </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Apply this clip region and all its logic operations to the default window. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname"><a class="el" href="class_easy_x_plus_1_1_easy_except.html" title="The exception type used by EasyXPlus library. ">EasyExcept</a></td><td>If Window::init() is not called, it throws an excecption. If this function is called after calling <a class="el" href="class_easy_x_plus_1_1_rect_clip_region.html#a41bd2a048eee3d49781f712c3238f6f3" title="Clear the inner clip region and all logic operations on the inner clip region. ">clear()</a> but before <a class="el" href="class_easy_x_plus_1_1_rect_clip_region.html#aa87de1fd2b2357fb8e8b81c2550ad5d0" title="Set the inner clip region to the given region and clear all logic operations. ">set()</a>, it also throws an exception. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Users can call this function many times so long as the inner clip region is valid. </dd></dl>

<p>Implements <a class="el" href="class_easy_x_plus_1_1_clip_region.html">EasyXPlus::ClipRegion</a>.</p>

</div>
</div>
<a id="ac9e43a3a7d481b786a9a57efa814b8ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9e43a3a7d481b786a9a57efa814b8ff">&#9670;&nbsp;</a></span>cancelAssociation()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void EasyXPlus::RectClipRegion::cancelAssociation </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Cancel applying the clip region. </p>
<p>After canceling association, the clip region is remove from the default window. </p><dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname"><a class="el" href="class_easy_x_plus_1_1_easy_except.html" title="The exception type used by EasyXPlus library. ">EasyExcept</a></td><td>If this function is called after calling <a class="el" href="class_easy_x_plus_1_1_rect_clip_region.html#a41bd2a048eee3d49781f712c3238f6f3" title="Clear the inner clip region and all logic operations on the inner clip region. ">clear()</a> but before <a class="el" href="class_easy_x_plus_1_1_rect_clip_region.html#aa87de1fd2b2357fb8e8b81c2550ad5d0" title="Set the inner clip region to the given region and clear all logic operations. ">set()</a>, it throw an exception. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Users can call this function many times so long as the inner clip region is valid. </dd></dl>

<p>Implements <a class="el" href="class_easy_x_plus_1_1_clip_region.html">EasyXPlus::ClipRegion</a>.</p>

</div>
</div>
<a id="a41bd2a048eee3d49781f712c3238f6f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41bd2a048eee3d49781f712c3238f6f3">&#9670;&nbsp;</a></span>clear()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void EasyXPlus::RectClipRegion::clear </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Clear the inner clip region and all logic operations on the inner clip region. </p>
<dl class="section note"><dt>Note</dt><dd>Generally, users should call <a class="el" href="class_easy_x_plus_1_1_rect_clip_region.html#aa87de1fd2b2357fb8e8b81c2550ad5d0" title="Set the inner clip region to the given region and clear all logic operations. ">set()</a> after this function call. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="easy_clip_8h_source.html">easyClip.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
